v0.42.0: 🌻

Compare Source

This version introduces features released on Meilisearch v1.10.0 🎉
Check out the changelog of Meilisearch v1.10.0 for more information on the changes.

⚠️ Breaking changes

• Improve errors (#​1656) @​/flevi29
  More details here
• Changes related to Hybrid search (experimental) for the REST embedder (#​1692) @​mdubus
  • Removed parameters: query, inputField, inputType, pathToEmbeddings and embeddingObject.
  • Replaced by request and response
  • New parameter: headers

🚀 Enhancements

• Hybrid search improvements (#​1692) @​mdubus

  • Add url parameter to the OpenAI embedder
  • dimensions is now available as an optional parameter for ollama embedders.

• Add federated search parameters (#​1689) @​flevi29

client.multiSearch({
    federation: {},
    queries: [
      {
        indexUid: 'movies',
        q: 'batman',
        limit: 5,
      },
      {
        indexUid: 'comics',
        q: 'batman',
        limit: 5,
      },
    ]
  })

• Add capabilities to update documents by function (#​1691) @​flevi29

index.updateDocumentsByFunction({
    context: { ctx: 'Harry' },
    filter: 'id = 4',
    function: 'doc.comment = `Yer a wizard, ${context.ctx}!`',
  })
)

• Add language settings (#​1693) @​/flevi29

client.index('INDEX_NAME').updateLocalizedAttributes([
    { attributePatterns: ['jpn'], locales: ['*_ja'] },
];)

• Add locale search parameter (#​1693) @​flevi29

client.index('INDEX_NAME').search('進撃の巨人', { locales: ['jpn'] })

⚙️ Maintenance/misc

• Add JS hosted documentation (#​1678) @​amit-ksh

Thanks again to @​amit-ksh, @​brunoocasali, @​curquiza, @​flevi29, @​mdubus, @​meili-bors[bot] ! 🎉

v0.41.0: 🌻

Compare Source

This version introduces features released on Meilisearch v1.9.0 🎉
Check out the changelog of Meilisearch v1.9.0 for more information on the changes.

🚀 Enhancements

• Add frequency matching strategy (#​1670) @​the-sinner

client.index('movies').search('interstellar', { matchingStrategy: MatchingStrategies.FREQUENCY });

• Add rankingScoreThreshold in search (#​1669) @​the-sinner and in searchGet (#​1673) @​mdubus

client.index('movies').search('badman', { rankingScoreThreshold: 0.2 });
client.index('movies').searchGet('badman', { rankingScoreThreshold: 0.2 });

• feat: add attribute at search (#​1676) @​mdubus

client.index('movies').search('', { distinct: 'genre' });

• feat: get similar documents (#​1677) @​mdubus

client.index('movies').searchSimilarDocuments({ id: 'target-document-id' });

• feat: hybrid search changes (#​1679) @​mdubus

client.index('movies').getDocuments({ retrieveVectors: true });

🔒 Security

• build(deps): bump ws from 5.2.3 to 5.2.4 in /playgrounds/javascript (#​1672)

⚙️ Maintenance/misc

• Remove unneeded comments from config files (#​1657) @​flevi29
• Fix release version check script (#​1681) @​curquiza

Thanks again to @​brunoocasali, @​curquiza, @​flevi29, @​mdubus, and @​the-sinner! 🎉

v0.40.0: 🌻

Compare Source

💥 Breaking Changes

• Fix the issue introduced in the v0.39 that affected vite apps https://github.com/meilisearch/meilisearch-js/pull/1652 @​brunoocasali
• Now to use the generateTenantToken you should use it with await:
  before:

  const token = client.generateTenantToken(apiKeyUid, searchRules, {
      apiKey: apiKey,
      expiresAt: expiresAt,
    })

  after:

  const token = await client.generateTenantToken(apiKeyUid, searchRules, {
      apiKey: apiKey,
      expiresAt: expiresAt,
    })

⚙️ Maintenance/misc

• Update readme links to the documentation (#​1650) @​mdubus

Thanks again to @​brunoocasali, @​mdubus! 🎉

v0.39.0: 🌻

Compare Source

🚀 Enhancements

• feat: hybrid search improvements for v1.8.x (#​1647) @​mdubus
• Add null to Embedder type (#​1646) @​amit-ksh
• Add searchCutoffMs index setting (#​1643, #​1645) @​amit-ksh

  client.index('movies').getSearchCutoffMs()
  client.index('movies').updateSearchCutoffMs(150)
  client.index('movies').resetSearchCutoffMs()

⚠️ if you're using vite to build your front-end app, you must add this to your configuration (see more info here https://github.com/meilisearch/meilisearch-js/issues/1649)

export default defineConfig({
  plugins: [vue()],
  build: {
    rollupOptions: {
      external: ['crypto'], // this is the important part
    },
  },
})

Otherwise, you'll face errors like Module "crypto" has been externalized for browser compatibility.

⚙️ Maintenance/misc

• Update ESLint, Prettier, TypeScript and fix/improve their configuration files (#​1616) @​flevi29
• Fix code style after configuration changes (#​1638) @​brunoocasali

Thanks again to @​amit-ksh, @​brunoocasali, @​curquiza, @​flevi29, @​mdubus! 🎉

v0.38.0: 🌻

Compare Source

This version introduces features released on Meilisearch v1.7.0 🎉
Check out the changelog of Meilisearch v1.7.0 for more information on the changes.

⚠️ If you want to adopt new features of this release, update the Meilisearch server to the appropriate version.

⚠️ Breaking changes

• Update Node.js versions that are used in tests (#​1620) @​flevi29
• scoreDetails feature is not experimental anymore. You can directly use showRankingScoreDetails during a search without activating the experimental feature 🎉

🚀 Enhancements

• dimensions field is available to the OpenAi model (#​1631) @​nicolasvienot
• Enable limit and offset according to documentation. (#​1630) @​reijovosu

v0.37.0: 🌻

Compare Source

This version introduces features released on Meilisearch v1.6.0 🎉
Check out the changelog of Meilisearch v1.6.0 for more information on the changes.

⚠️ If you want to adopt new features of this release, update the Meilisearch server to the according version.

🚀 Enhancements

• Add support for the new setting: proximityPrecision (https://github.com/meilisearch/meilisearch-js/pull/1619) mdubus

client.index('books').getProximityPrecision()
client.index('books').updateProximityPrecision('byAttribute')
client.index('books').resetProximityPrecision()

• Update error inheritance to extend MeiliSearchError (#​1607) amit-ksh

🧪 Experimental enhancement - Hybrid and vector search

⚠️ This is about an experimental feature of Meilisearch. Activate the vectorStore experimental feature to use it

• Add support for the embedders settings (https://github.com/meilisearch/meilisearch-js/pull/1623) mdubus

client.index('books').getEmbedders()
client.index('books').updateEmbedders({ default: { source: 'userProvided', dimensions: 1 }})
client.index('books').resetEmbedders()

• Add support for the hybrid parameter during search (https://github.com/meilisearch/meilisearch-js/pull/1623) mdubus

⚙️ Maintenance/misc

• Fix test name in error.test.ts (#​1609) amit-ksh
• Update Jest (#​1622) flevi29

Thanks again to @​amit-ksh, @​curquiza, @​flevi29, @​mdubus, @​meili-bors[bot] ! 🎉

v0.36.0: 🌻

Compare Source

This version introduces features released on Meilisearch v1.5.0 🎉
Check out the changelog of Meilisearch v1.5.0 for more information on the changes.

⚠️ If you want to adopt new features of this release, update the Meilisearch server to the appropriate version.

🚀 Enhancements

• Needs Meilisearch v1.5.0 -> Add new method createSnapshot() to trigger snapshot creation. Similar to the already existing createDump() for dumps (#​1603) @​brunoocasali

v0.35.1: 🌻

Compare Source

🚀 Enhancements

• Add request timeout (#​1554) @​amit-ksh
• Fix const enum issues (#​1593) @​jonespen
• feat: add export for MeiliSearch as Meilisearch (#​1601) @​Dhoni77

Thanks again to @​Dhoni77, @​amit-ksh, @​curquiza, @​jonespen, @​meili-bors[bot] ! 🎉

v0.35.0: 🌻

Compare Source

This version introduces features released on Meilisearch v1.4.0 🎉
Check out the changelog of Meilisearch v1.4.0 for more information on the changes.

⚠️ If you want to adopt new features of this release, update the Meilisearch server to the according version.

🚀 Enhancements

• Add support for the new setting: dictionary (#​1563) @​atoulmet

client.index('books').getDictionary()
client.index('books').updateDictionary(['W.E.B'])
client.index('books').resetDictionary()

• Add support for the new setting: separator-tokens (#​1563) @​atoulmet

client.index('books').getSeparatorTokens()
client.index('books').updateSeparatorTokens(['@​'])
client.index('books').resetSeparatorTokens()

• Add support for the new setting: non-separator-tokens (#​1563) @​atoulmet

client.index('books').getNonSeparatorTokens()
client.index('books').updateNonSeparatorTokens(['.', ','])
client.index('books').resetNonSeparatorTokens()

⚠️ Warning usage with v1.4.0

A bug fix in Meilisearch v1.4.0 introduces a breaking change in the filter usage. It only concerns users using the filter search parameter with \.
Explanation and change to apply are detailed in the Meilisearch v1.4.0

Thanks to @​atoulmet and @​bidoubiwa! 🎉